<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /*<a name="line.1"></a>
<FONT color="green">002</FONT>     * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<FONT color="green">003</FONT>     * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<FONT color="green">004</FONT>     * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<FONT color="green">005</FONT>     * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<FONT color="green">006</FONT>     * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<FONT color="green">007</FONT>     * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<FONT color="green">008</FONT>     *<a name="line.8"></a>
<FONT color="green">009</FONT>     *      http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<FONT color="green">010</FONT>     *<a name="line.10"></a>
<FONT color="green">011</FONT>     * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<FONT color="green">012</FONT>     * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<FONT color="green">013</FONT>     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<FONT color="green">014</FONT>     * See the License for the specific language governing permissions and<a name="line.14"></a>
<FONT color="green">015</FONT>     * limitations under the License.<a name="line.15"></a>
<FONT color="green">016</FONT>     */<a name="line.16"></a>
<FONT color="green">017</FONT>    package org.apache.commons.math3.stat.regression;<a name="line.17"></a>
<FONT color="green">018</FONT>    <a name="line.18"></a>
<FONT color="green">019</FONT>    import org.apache.commons.math3.exception.MathIllegalArgumentException;<a name="line.19"></a>
<FONT color="green">020</FONT>    import org.apache.commons.math3.exception.NoDataException;<a name="line.20"></a>
<FONT color="green">021</FONT>    <a name="line.21"></a>
<FONT color="green">022</FONT>    /**<a name="line.22"></a>
<FONT color="green">023</FONT>     * An interface for regression models allowing for dynamic updating of the data.<a name="line.23"></a>
<FONT color="green">024</FONT>     * That is, the entire data set need not be loaded into memory. As observations<a name="line.24"></a>
<FONT color="green">025</FONT>     * become available, they can be added to the regression  model and an updated<a name="line.25"></a>
<FONT color="green">026</FONT>     * estimate regression statistics can be calculated.<a name="line.26"></a>
<FONT color="green">027</FONT>     *<a name="line.27"></a>
<FONT color="green">028</FONT>     * @version $Id: UpdatingMultipleLinearRegression.java 1392342 2012-10-01 14:08:52Z psteitz $<a name="line.28"></a>
<FONT color="green">029</FONT>     * @since 3.0<a name="line.29"></a>
<FONT color="green">030</FONT>     */<a name="line.30"></a>
<FONT color="green">031</FONT>    public interface UpdatingMultipleLinearRegression {<a name="line.31"></a>
<FONT color="green">032</FONT>    <a name="line.32"></a>
<FONT color="green">033</FONT>        /**<a name="line.33"></a>
<FONT color="green">034</FONT>         * Returns true if a constant has been included false otherwise.<a name="line.34"></a>
<FONT color="green">035</FONT>         *<a name="line.35"></a>
<FONT color="green">036</FONT>         * @return true if constant exists, false otherwise<a name="line.36"></a>
<FONT color="green">037</FONT>         */<a name="line.37"></a>
<FONT color="green">038</FONT>        boolean hasIntercept();<a name="line.38"></a>
<FONT color="green">039</FONT>    <a name="line.39"></a>
<FONT color="green">040</FONT>        /**<a name="line.40"></a>
<FONT color="green">041</FONT>         * Returns the number of observations added to the regression model.<a name="line.41"></a>
<FONT color="green">042</FONT>         *<a name="line.42"></a>
<FONT color="green">043</FONT>         * @return Number of observations<a name="line.43"></a>
<FONT color="green">044</FONT>         */<a name="line.44"></a>
<FONT color="green">045</FONT>        long getN();<a name="line.45"></a>
<FONT color="green">046</FONT>    <a name="line.46"></a>
<FONT color="green">047</FONT>        /**<a name="line.47"></a>
<FONT color="green">048</FONT>         * Adds one observation to the regression model.<a name="line.48"></a>
<FONT color="green">049</FONT>         *<a name="line.49"></a>
<FONT color="green">050</FONT>         * @param x the independent variables which form the design matrix<a name="line.50"></a>
<FONT color="green">051</FONT>         * @param y the dependent or response variable<a name="line.51"></a>
<FONT color="green">052</FONT>         * @throws ModelSpecificationException if the length of {@code x} does not equal<a name="line.52"></a>
<FONT color="green">053</FONT>         * the number of independent variables in the model<a name="line.53"></a>
<FONT color="green">054</FONT>         */<a name="line.54"></a>
<FONT color="green">055</FONT>        void addObservation(double[] x, double y) throws ModelSpecificationException;<a name="line.55"></a>
<FONT color="green">056</FONT>    <a name="line.56"></a>
<FONT color="green">057</FONT>        /**<a name="line.57"></a>
<FONT color="green">058</FONT>         * Adds a series of observations to the regression model. The lengths of<a name="line.58"></a>
<FONT color="green">059</FONT>         * x and y must be the same and x must be rectangular.<a name="line.59"></a>
<FONT color="green">060</FONT>         *<a name="line.60"></a>
<FONT color="green">061</FONT>         * @param x a series of observations on the independent variables<a name="line.61"></a>
<FONT color="green">062</FONT>         * @param y a series of observations on the dependent variable<a name="line.62"></a>
<FONT color="green">063</FONT>         * The length of x and y must be the same<a name="line.63"></a>
<FONT color="green">064</FONT>         * @throws ModelSpecificationException if {@code x} is not rectangular, does not match<a name="line.64"></a>
<FONT color="green">065</FONT>         * the length of {@code y} or does not contain sufficient data to estimate the model<a name="line.65"></a>
<FONT color="green">066</FONT>         */<a name="line.66"></a>
<FONT color="green">067</FONT>        void addObservations(double[][] x, double[] y) throws ModelSpecificationException;<a name="line.67"></a>
<FONT color="green">068</FONT>    <a name="line.68"></a>
<FONT color="green">069</FONT>        /**<a name="line.69"></a>
<FONT color="green">070</FONT>         * Clears internal buffers and resets the regression model. This means all<a name="line.70"></a>
<FONT color="green">071</FONT>         * data and derived values are initialized<a name="line.71"></a>
<FONT color="green">072</FONT>         */<a name="line.72"></a>
<FONT color="green">073</FONT>        void clear();<a name="line.73"></a>
<FONT color="green">074</FONT>    <a name="line.74"></a>
<FONT color="green">075</FONT>    <a name="line.75"></a>
<FONT color="green">076</FONT>        /**<a name="line.76"></a>
<FONT color="green">077</FONT>         * Performs a regression on data present in buffers and outputs a RegressionResults object<a name="line.77"></a>
<FONT color="green">078</FONT>         * @return RegressionResults acts as a container of regression output<a name="line.78"></a>
<FONT color="green">079</FONT>         * @throws ModelSpecificationException if the model is not correctly specified<a name="line.79"></a>
<FONT color="green">080</FONT>         * @throws NoDataException if there is not sufficient data in the model to<a name="line.80"></a>
<FONT color="green">081</FONT>         * estimate the regression parameters<a name="line.81"></a>
<FONT color="green">082</FONT>         */<a name="line.82"></a>
<FONT color="green">083</FONT>        RegressionResults regress() throws ModelSpecificationException, NoDataException;<a name="line.83"></a>
<FONT color="green">084</FONT>    <a name="line.84"></a>
<FONT color="green">085</FONT>        /**<a name="line.85"></a>
<FONT color="green">086</FONT>         * Performs a regression on data present in buffers including only regressors<a name="line.86"></a>
<FONT color="green">087</FONT>         * indexed in variablesToInclude and outputs a RegressionResults object<a name="line.87"></a>
<FONT color="green">088</FONT>         * @param variablesToInclude an array of indices of regressors to include<a name="line.88"></a>
<FONT color="green">089</FONT>         * @return RegressionResults acts as a container of regression output<a name="line.89"></a>
<FONT color="green">090</FONT>         * @throws ModelSpecificationException if the model is not correctly specified<a name="line.90"></a>
<FONT color="green">091</FONT>         * @throws MathIllegalArgumentException if the variablesToInclude array is null or zero length<a name="line.91"></a>
<FONT color="green">092</FONT>         */<a name="line.92"></a>
<FONT color="green">093</FONT>        RegressionResults regress(int[] variablesToInclude) throws ModelSpecificationException, MathIllegalArgumentException;<a name="line.93"></a>
<FONT color="green">094</FONT>    }<a name="line.94"></a>




























































</PRE>
</BODY>
</HTML>
